accurrent2 2.2.1
Loading...
Searching...
No Matches
accurrent2.h File Reference

This file contains API for AC Current 2 Click Driver. More...

#include "drv_digital_out.h"
#include "drv_digital_in.h"
#include "drv_analog_in.h"
#include "drv_i2c_master.h"

Go to the source code of this file.

Data Structures

struct  accurrent2_t
 AC Current 2 Click context object. More...
struct  accurrent2_cfg_t
 AC Current 2 Click configuration object. More...

Macros

#define ACCURRENT2_AC_TO_DC_V_SCALE   1.8f
 AC Current 2 current measurement calculation values.
#define ACCURRENT2_SENSOR_RESOLUTION   30.0f
#define ACCURRENT2_NUM_CONVERSIONS   200
 AC Current 2 default ADC samples number for averaging.
#define ACCURRENT2_ADC_RESOLUTION   0x0FFF
 AC Current 2 ADC setting.
#define ACCURRENT2_VREF_3V3   3.3
#define ACCURRENT2_VREF_5V   5.0
#define ACCURRENT2_TIMEOUT_MS   2000
 AC Current 2 timeout setting.
#define ACCURRENT2_SET_DEV_ADDR   0x4D
 AC Current 2 device address setting.
#define ACCURRENT2_MAP_MIKROBUS(cfg, mikrobus)
 MikroBUS pin mapping.

Enumerations

enum  accurrent2_drv_t { ACCURRENT2_DRV_SEL_ADC , ACCURRENT2_DRV_SEL_I2C }
 AC Current 2 Click driver selector. More...
enum  accurrent2_return_value_t { ACCURRENT2_OK = 0 , ACCURRENT2_ERROR = -1 }
 AC Current 2 Click return value data. More...

Functions

void accurrent2_cfg_setup (accurrent2_cfg_t *cfg)
 AC Current 2 configuration object setup function.
void accurrent2_drv_interface_sel (accurrent2_cfg_t *cfg, accurrent2_drv_t drv_sel)
 AC Current 2 driver interface setup function.
err_t accurrent2_init (accurrent2_t *ctx, accurrent2_cfg_t *cfg)
 AC Current 2 initialization function.
err_t accurrent2_read_raw_adc (accurrent2_t *ctx, uint16_t *raw_adc)
 AC Current 2 read raw ADC value function.
err_t accurrent2_read_voltage (accurrent2_t *ctx, float *voltage)
 AC Current 2 read voltage level function.
err_t accurrent2_read_voltage_avg (accurrent2_t *ctx, uint16_t num_conv, float *voltage_avg)
 AC Current 2 read average voltage level function.
err_t accurrent2_set_vref (accurrent2_t *ctx, float vref)
 AC Current 2 set vref function.
err_t accurrent2_read_current (accurrent2_t *ctx, float *current)
 AC Current 2 read current function.

Detailed Description

This file contains API for AC Current 2 Click Driver.

Enumeration Type Documentation

◆ accurrent2_drv_t

AC Current 2 Click driver selector.

Selects target driver interface of AC Current 2 Click driver.

Enumerator
ACCURRENT2_DRV_SEL_ADC 

ADC driver descriptor.

ACCURRENT2_DRV_SEL_I2C 

I2C driver descriptor.

◆ accurrent2_return_value_t

AC Current 2 Click return value data.

Predefined enum values for driver return values.

Enumerator
ACCURRENT2_OK 
ACCURRENT2_ERROR